<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>EJAM/EJSCREEN comparisons - compare EJScreen API vs EJAM stats at tested sites — ejscreen_vs_ejam • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="EJAM/EJSCREEN comparisons - compare EJScreen API vs EJAM stats at tested sites — ejscreen_vs_ejam"><meta name="description" content="Used by ejscreen_vs()"><meta property="og:description" content="Used by ejscreen_vs()"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/USEPA/EJAM/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>EJAM/EJSCREEN comparisons - compare EJScreen API vs EJAM stats at tested sites</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/ejscreen_vs_ejam_.R" class="external-link"><code>R/ejscreen_vs_ejam_.R</code></a></small>
      <div class="d-none name"><code>ejscreen_vs_ejam.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Used by <code><a href="ejscreen_vs.html">ejscreen_vs()</a></code></p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">ejscreen_vs_ejam</span><span class="op">(</span></span>
<span>  <span class="va">latlon</span>,</span>
<span>  radius <span class="op">=</span> <span class="fl">3</span>,</span>
<span>  fips <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  shapefile <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  nadrop <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  save_ejscreen_output <span class="op">=</span> <span class="st">"ejscreenapi_plus_out.rda"</span>,</span>
<span>  save_when_report <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  report_every_n <span class="op">=</span> <span class="fl">250</span>,</span>
<span>  calculate_ratios <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  include_ejindexes <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  x100fix <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  x100varnames <span class="op">=</span> <span class="va">names_pct_as_fraction_ejamit</span>,</span>
<span>  showdrinkingwater <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  showpctowned <span class="op">=</span> <span class="cn">TRUE</span>,</span>
<span>  <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-latlon">latlon<a class="anchor" aria-label="anchor" href="#arg-latlon"></a></dt>
<dd><p>data.table or data.frame with colnames lat and lon,
and one row per site</p></dd>


<dt id="arg-radius">radius<a class="anchor" aria-label="anchor" href="#arg-radius"></a></dt>
<dd><p>in miles, used in ejamit() and ejscreenapi_plus()</p></dd>


<dt id="arg-fips">fips<a class="anchor" aria-label="anchor" href="#arg-fips"></a></dt>
<dd><p>FIPS code(s) of counties or blockgroups, if not using latlon and radius.</p></dd>


<dt id="arg-save-ejscreen-output">save_ejscreen_output<a class="anchor" aria-label="anchor" href="#arg-save-ejscreen-output"></a></dt>
<dd><p>set to NULL or FALSE to avoid saving ejscreen results locally.
If specified as a valid path and filename ending in .rda, it saves there.
If missing, function will prompt in interactive R session
for a folder to use for saving the .rda results of ejscreenapi</p></dd>


<dt id="arg-save-when-report">save_when_report<a class="anchor" aria-label="anchor" href="#arg-save-when-report"></a></dt>
<dd><p>see <code><a href="ejscreenapi_plus.html">ejscreenapi_plus()</a></code>, to save progress every so often just in case.</p></dd>


<dt id="arg-report-every-n">report_every_n<a class="anchor" aria-label="anchor" href="#arg-report-every-n"></a></dt>
<dd><p>see ejscreenapi_plus()</p></dd>


<dt id="arg-calculate-ratios">calculate_ratios<a class="anchor" aria-label="anchor" href="#arg-calculate-ratios"></a></dt>
<dd><p>passed to ejscreenapi_plus() and <code><a href="ejamit.html">ejamit()</a></code></p></dd>


<dt id="arg-include-ejindexes">include_ejindexes<a class="anchor" aria-label="anchor" href="#arg-include-ejindexes"></a></dt>
<dd><p>passed to ejscreenapi_plus() and <code><a href="ejamit.html">ejamit()</a></code></p></dd>


<dt id="arg-x-fix">x100fix<a class="anchor" aria-label="anchor" href="#arg-x-fix"></a></dt>
<dd><p>whether to multiply x100 in ejamit() outputs the names_d and names_d_subgroups
indicator scores to convert fractions 0 to 1 into percentages of 0 to 100,
prior to rounding and reporting EJAM results here.</p></dd>


<dt id="arg-x-varnames">x100varnames<a class="anchor" aria-label="anchor" href="#arg-x-varnames"></a></dt>
<dd><p>optional, if x100fix = TRUE, a vector of colnames of x$EJAM to convert from
being scaled as 0 to 1 into rescaled values of 0 to 100, because some
outputs of EJSCREEN were reported as percentages 0 to 100 but as 0 to 1 in EJAM.</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>passed to ejamit() as any additional parameters</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>a list of data frames, with names
EJSCREEN, EJAM, EJSCREEN_shown, EJAM_shown, same_shown,
ratio, diff, absdiff, pctdiff, abspctdiff</p>
<p>diff is EJAM - EJSCREEN</p>
<p>ratio is EJAM / EJSCREEN</p>
<p>pctdiff is ratio - 1</p>
<p>abs is absolute value</p>
<p>For each data.frame, colnames are indicators like pop, blockcount_near_site, etc.
and rows represent sites analyzed.</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>Consider using <code><a href="ejscreen_vs.html">ejscreen_vs()</a></code> which does this all interactively.</p>
<p><code>ejscreen_vs_ejam()</code> and <code><a href="ejscreen_vs_ejam_alreadyrun.html">ejscreen_vs_ejam_alreadyrun()</a></code> are used by <code><a href="ejscreen_vs.html">ejscreen_vs()</a></code></p>
    </div>
    <div class="section level2">
    <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"></a></h2>
    <div class="dont-index"><p><code><a href="ejscreen_vs.html">ejscreen_vs()</a></code> which does it all interactively, and uses <code><a href="ejscreen_vs_ejam_alreadyrun.html">ejscreen_vs_ejam_alreadyrun()</a></code> if appropriate.</p></div>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span> <span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span>
<span> <span class="co"># in RStudio, interactive:</span></span>
<span> <span class="va">vs</span> <span class="op">&lt;-</span> <span class="fu"><a href="ejscreen_vs.html">ejscreen_vs</a></span><span class="op">(</span><span class="op">)</span></span>
<span> </span>
<span> <span class="co"># vs filtered to just the ones where rounded pop disagrees</span></span>
<span> <span class="fu"><a href="https://rdrr.io/r/base/table.html" class="external-link">table</a></span><span class="op">(</span><span class="va">vs</span><span class="op">$</span><span class="va">same_shown</span><span class="op">$</span><span class="va">pop</span><span class="op">)</span></span>
<span> <span class="va">vspopoff</span> <span class="op">&lt;-</span> <span class="fu"><a href="https://rdrr.io/r/base/lapply.html" class="external-link">lapply</a></span><span class="op">(</span><span class="va">vs</span>, <span class="kw">function</span><span class="op">(</span><span class="va">x</span><span class="op">)</span> <span class="va">x</span><span class="op">[</span><span class="op">!</span><span class="va">vs</span><span class="op">$</span><span class="va">same_shown</span><span class="op">$</span><span class="va">pop</span>, <span class="op">]</span><span class="op">)</span></span>
<span> </span>
<span> <span class="va">pts2</span> <span class="op">&lt;-</span> <span class="va">testpoints_100</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">2</span>, <span class="op">]</span></span>
<span> <span class="va">vs2</span> <span class="op">&lt;-</span> <span class="fu">ejscreen_vs_ejam</span><span class="op">(</span><span class="va">pts2</span>, radius <span class="op">=</span> <span class="fl">1</span>, save_ejscreen_output <span class="op">=</span> <span class="cn">F</span> <span class="op">)</span></span>
<span>  <span class="op">}</span> <span class="co"># }</span></span></code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2024</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

